Incorporate experimental and alpha features #4213

akeller · 2024-08-29T16:41:44Z

Description

This PR creates an "Experimental" and "alpha" section in the Components area of the docs with a landing page, SAP, and RPA documentation.

When should this change go live?

This is a bug fix, security concern, or something that needs urgent release support.
This is already available but undocumented and should be released within a week.
This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR) To release Oct 15 for CCon
This is part of a scheduled alpha or minor. (apply alpha or minor label)
There is no urgency with this change and can be released at any time.

PR Checklist

My changes are for an already released minor and are in /versioned_docs directory.
My changes are for the next minor and are in /docs directory (aka /next/).

My changes require an Engineering review, and I've assigned the Engineering DRI or delegate.
My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.

lmbateman

This seems fine to me. I can see it under Next but not 8.5, which I think is the goal.

PhilippaC22 · 2024-09-02T11:21:51Z

@christinaausley structure looks good - Have added some design suggestions around this here as well as naming ideas too.
See Figjam

akeller · 2024-09-05T21:41:17Z

We won't use "experimental" in the official, shipped version. See my update on Slack - https://camunda.slack.com/archives/C0484UFR2VA/p1725571619654449

christinaausley · 2024-09-17T13:20:11Z

@camundom @melanie-butcher sounds like you are perhaps putting together some design ideas? Do we have any strong opinions around some of the potential naming terms based on the Slack thread linked above? Also happy to hop on a call and discuss.

camundom · 2024-09-19T07:47:13Z

@camundom @melanie-butcher sounds like you are perhaps putting together some design ideas? Do we have any strong opinions around some of the potential naming terms based on the Slack thread linked above? Also happy to hop on a call and discuss.

Hi @christinaausley, here's a link to the draft design for the docs, includes a revised structure for early access/experimental features, along with few open questions. Please let me know what you think.

christinaausley · 2024-10-03T17:33:17Z

Thanks for meeting with me today @camundom -- please let me know if I can assist with incorporating the changes here once the finalities of the design are discussed with @bastiankoerber.

akeller · 2024-10-07T14:58:52Z

Removing deploy since it's currently broken. 😢

christinaausley · 2024-10-09T13:40:23Z

Hi @camundom -- based on your draft design, can I go ahead and update this PR so we have a place to put content before CCon?

christinaausley · 2024-10-09T14:36:09Z

@akeller It's looking like I can start pulling some experimental CCon documentation into GitHub. How do we feel about merging those into this branch once the structure is ready to go?

akeller · 2024-10-09T18:11:59Z

@akeller It's looking like I can start pulling some experimental CCon documentation into GitHub. How do we feel about merging those into this branch once the structure is ready to go?

Doesn't matter to me! I'll leave it with the team to decide on names, etc. Also if it's easier to close this PR out and start fresh, that works too.

camundom · 2024-10-10T05:12:20Z

Hi @camundom -- based on your draft design, can I go ahead and update this PR so we have a place to put content before CCon?

Hi @christinaausley , yes that can be done. I've also received final approval to the design/structure that would be used for CCon. Please let me know if there's any way that I can help you with this. Thanks

christinaausley · 2024-10-10T17:03:40Z

Thanks @camundom -- prepping this today and tomorrow.

* initial poc commit * wip: sap odata connector * wip: further docs * docs: spell check * feat: first draft of the sap docs * initial edits * revise rfc connector * remove from sidebar for now * Update docs/guides/sap/btp-integration.md Co-authored-by: Cole Isaac <[email protected]> * Update docs/guides/sap/camunda-sap-integration.md Co-authored-by: Cole Isaac <[email protected]> * Update docs/guides/sap/rfc-connector.md Co-authored-by: Cole Isaac <[email protected]> * resolve comments * second review of sap content * fix link * resolve comments * move into components for now * Update docs/components/sap/odata-connector.md Co-authored-by: Mark Sellings <[email protected]> * Update docs/components/sap/odata-connector.md Co-authored-by: Mark Sellings <[email protected]> * Update docs/components/sap/odata-connector.md Co-authored-by: Mark Sellings <[email protected]> * Update docs/components/sap/rfc-connector.md Co-authored-by: Mark Sellings <[email protected]> * Update docs/components/sap/rfc-connector.md Co-authored-by: Mark Sellings <[email protected]> * Update docs/components/sap/rfc-connector.md Co-authored-by: Mark Sellings <[email protected]> --------- Co-authored-by: Volker Buzek <[email protected]> Co-authored-by: Volker Buzek <[email protected]> Co-authored-by: Volker Buzek <[email protected]> Co-authored-by: Christina Ausley <[email protected]> Co-authored-by: christinaausley <[email protected]> Co-authored-by: Cole Isaac <[email protected]> Co-authored-by: Mark Sellings <[email protected]>

christinaausley · 2024-10-14T15:28:46Z

This is ready for final review -- I will plan to release this tomorrow afternoon. CC @bastiankoerber

github-actions · 2024-10-14T19:40:15Z

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.

docs/components/early-access/alpha/sap/btp-integration.md
docs/components/early-access/alpha/sap/camunda-sap-integration.md
docs/components/early-access/alpha/sap/img/btp-destination-rfc.png
docs/components/early-access/alpha/sap/img/btp-destination.png
docs/components/early-access/alpha/sap/img/odata-connector-error-expression.png
docs/components/early-access/alpha/sap/img/odata-steps.png
docs/components/early-access/alpha/sap/img/rfc-overview.png
docs/components/early-access/alpha/sap/img/sap-integration-overview.png
docs/components/early-access/alpha/sap/img/sap-odata-connector-element-template-advanced.png
docs/components/early-access/alpha/sap/img/sap-odata-connector-element-template-result.png
docs/components/early-access/alpha/sap/img/sap-odata-connector-element-template.png
docs/components/early-access/alpha/sap/img/sap-odata-connector-task-error-handling1.png
docs/components/early-access/alpha/sap/img/sap-odata-connector-task-error-handling2.png
docs/components/early-access/alpha/sap/img/sap-odata-connector-task-in-model.png
docs/components/early-access/alpha/sap/img/sap-rfc-connector-element-template.png
docs/components/early-access/alpha/sap/img/sap-rfc-connector-task-in-model.png
docs/components/early-access/alpha/sap/odata-connector.md
docs/components/early-access/alpha/sap/rfc-connector.md
docs/components/early-access/experimental/rpa/camunda-rpa-framework-library.md
docs/components/early-access/experimental/rpa/img/rpa-task-example.png
docs/components/early-access/experimental/rpa/img/testing-rpa.png
docs/components/early-access/experimental/rpa/rpa-integration-with-camunda.md
docs/components/early-access/overview.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

mesellings

I've reviewed the overview page but have already reviewed the other pages - just one possibly blocking issue with the table rows, but I'm aware you want to emrge this today so approving as this can be done ina. follow-up PR 👍

docs/components/early-access/overview.md

mesellings · 2024-10-15T07:11:39Z

docs/components/early-access/overview.md

+
+## Alpha features
+
+Alpha features are more developed and closer to becoming part of the product but may not yet be fully optimized or supported. Selected Camunda features and components are released as alpha versions to provide early access. By testing these features, you have the opportunity to participate in their development by sharing feedback before they reach General Availability (GA).


Do we want to link to the Alpha features page? https://docs.camunda.io/docs/next/reference/alpha-features/

Honestly we could probably move this entire page over as an "overview" to the alpha features section, but I consider that out of scope for this PR. Will open an additional issue to revisit.

I was going to provide similar feedback - we include definitions or explanations for alphas and minors on the release policy page as well. These should be linked so they reference each other. I'm ok with this being handled in a separate PR.

Cool. I'll launch another PR. Can I get a final approval from one of you so I can go ahead and release this?

mesellings

Lgtm - great work! 🥇 👍

github-actions · 2024-10-15T16:44:08Z

🧹 Preview environment for this PR has been torn down.

initial 4 feature structure

a69b9fb

akeller added hold This issue is parked, do not merge. deploy Stand up a temporary docs site with this PR labels Aug 29, 2024

akeller requested review from YanaSegal, bastiankoerber, lmbateman and PhilippaC22 August 29, 2024 16:41

akeller self-assigned this Aug 29, 2024

github-actions bot temporarily deployed to camunda-docs August 29, 2024 16:58 Destroyed

adjust sidebar behavior

eb27094

github-actions bot temporarily deployed to camunda-docs August 29, 2024 17:50 Destroyed

lmbateman reviewed Aug 30, 2024

View reviewed changes

akeller assigned christinaausley Sep 5, 2024

YanaSegal previously approved these changes Oct 7, 2024

View reviewed changes

akeller removed the deploy Stand up a temporary docs site with this PR label Oct 7, 2024

Merge branch 'main' into experimental-structure-PR

bad7ddc

akeller added the deploy Stand up a temporary docs site with this PR label Oct 9, 2024

github-actions bot temporarily deployed to camunda-docs October 9, 2024 18:33 Destroyed

Merge branch 'main' into experimental-structure-PR

66f0939

christinaausley and others added 5 commits October 14, 2024 10:07

fix broken link

914a642

update img path

342b451

update image path

fadb020

incorporate sap docs

904c846

christinaausley removed the hold This issue is parked, do not merge. label Oct 14, 2024

fix broken link

6ea1bfe

camunda deleted a comment from github-actions bot Oct 14, 2024

christinaausley marked this pull request as ready for review October 14, 2024 15:27

christinaausley changed the title ~~Experimental structure PR~~ Incorporate experimental and alpha features Oct 14, 2024

christinaausley requested review from vobu, marstamm and a team October 14, 2024 15:29

github-actions bot temporarily deployed to camunda-docs October 14, 2024 15:33 Destroyed

minor tweak

bb037e1

github-actions bot temporarily deployed to camunda-docs October 14, 2024 19:59 Destroyed

mesellings previously approved these changes Oct 15, 2024

View reviewed changes

resolve comments

eb1aa8f

christinaausley dismissed mesellings’s stale review via eb1aa8f October 15, 2024 13:34

typo

38d8cda

github-actions bot temporarily deployed to camunda-docs October 15, 2024 13:55 Destroyed

mesellings self-requested a review October 15, 2024 16:24

mesellings approved these changes Oct 15, 2024

View reviewed changes

christinaausley merged commit 6842397 into main Oct 15, 2024
7 checks passed

christinaausley deleted the experimental-structure-PR branch October 15, 2024 16:39

christinaausley mentioned this pull request Oct 15, 2024

migrate alpha feaures landing page #4465

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Incorporate experimental and alpha features #4213

Incorporate experimental and alpha features #4213

akeller commented Aug 29, 2024 •

edited by christinaausley

Loading

lmbateman left a comment

PhilippaC22 commented Sep 2, 2024

akeller commented Sep 5, 2024

christinaausley commented Sep 17, 2024 •

edited

Loading

camundom commented Sep 19, 2024

christinaausley commented Oct 3, 2024 •

edited

Loading

akeller commented Oct 7, 2024

christinaausley commented Oct 9, 2024

christinaausley commented Oct 9, 2024

akeller commented Oct 9, 2024

camundom commented Oct 10, 2024 •

edited

Loading

christinaausley commented Oct 10, 2024

christinaausley commented Oct 14, 2024

github-actions bot commented Oct 14, 2024

mesellings left a comment

mesellings Oct 15, 2024

christinaausley Oct 15, 2024

akeller Oct 15, 2024

christinaausley Oct 15, 2024

mesellings left a comment

github-actions bot commented Oct 15, 2024


		## Alpha features

		Alpha features are more developed and closer to becoming part of the product but may not yet be fully optimized or supported. Selected Camunda features and components are released as alpha versions to provide early access. By testing these features, you have the opportunity to participate in their development by sharing feedback before they reach General Availability (GA).

Incorporate experimental and alpha features #4213

Incorporate experimental and alpha features #4213

Conversation

akeller commented Aug 29, 2024 • edited by christinaausley Loading

Description

When should this change go live?

PR Checklist

lmbateman left a comment

Choose a reason for hiding this comment

PhilippaC22 commented Sep 2, 2024

akeller commented Sep 5, 2024

christinaausley commented Sep 17, 2024 • edited Loading

camundom commented Sep 19, 2024

christinaausley commented Oct 3, 2024 • edited Loading

akeller commented Oct 7, 2024

christinaausley commented Oct 9, 2024

christinaausley commented Oct 9, 2024

akeller commented Oct 9, 2024

camundom commented Oct 10, 2024 • edited Loading

christinaausley commented Oct 10, 2024

christinaausley commented Oct 14, 2024

github-actions bot commented Oct 14, 2024

mesellings left a comment

Choose a reason for hiding this comment

mesellings Oct 15, 2024

Choose a reason for hiding this comment

christinaausley Oct 15, 2024

Choose a reason for hiding this comment

akeller Oct 15, 2024

Choose a reason for hiding this comment

christinaausley Oct 15, 2024

Choose a reason for hiding this comment

mesellings left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 15, 2024

akeller commented Aug 29, 2024 •

edited by christinaausley

Loading

christinaausley commented Sep 17, 2024 •

edited

Loading

christinaausley commented Oct 3, 2024 •

edited

Loading

camundom commented Oct 10, 2024 •

edited

Loading